Add Blueprint Framework and FAQ document#87
Conversation
|
It seems there are some problems flagged by linters, I'll address that ASAP. |
Commenting for tracking that the original .docx format of this document was contributed to the OPI Project by myself/WorldTech IT. |
horms
force-pushed
the
blueprint-framework
branch
2 times, most recently
from
36926e5 to
2f74b60
Compare
Ignore MD059 - Link text should be descriptive This is flagged by the use of '[here]' multiple times in Docs/opi-scope.md. That can be addressed as desired. But in the meantime it seems just as well to disable this check. Doing so makes the tree clean with regards to lint checks. Link: https://github.com/DavidAnson/markdownlint/blob/main/doc/md059.md Signed-off-by: Simon Horman <simon.horman@redhat.com>
horms
force-pushed
the
blueprint-framework
branch
from
2f74b60 to
61f19c0
Compare
This document describes OPI blueprints. Original text supplied by Josh Brooks <josh@worldtechit.com>. Signed-off-by: Simon Horman <simon.horman@redhat.com>
Update formating to use first and second level headers in place of table-based formating. This seems more appropriate for a Markdown document. Signed-off-by: Simon Horman <simon.horman@redhat.com>
Attribution was split between the top and the bottom of the document. It seems clearer to gather it together at the top. Signed-off-by: Simon Horman <simon.horman@redhat.com>
This markdown document was created using an automated conversion from another format. Which did not line-wrap the text. Do so as that seems appropriate for a text file. The text is otherwise unmodified by this rather verbose change. Signed-off-by: Simon Horman <simon.horman@redhat.com>
horms
force-pushed
the
blueprint-framework
branch
from
61f19c0 to
cee570e
Compare
|
I corrected all the linting problems (all workflows are green). This included adding a new patch to ignore markdown check md059, which was failing prior to this pull request. |
pdp2shirts
left a comment
pdp2shirts
left a comment
There was a problem hiding this comment.
Approving so we can move forward. I will submit an issue for this file to change "open-source" to "open source" which is the LF approved style for these words.
Thanks Paul, and sorry for not being aware of that before I created this PR. Do feel free to tag me for review. |
5 participants
Provide a document that outlines a the framework for blueprints and provides a FAQ.
This work was contributed by @josh-wtit.
I have made only formatting changes.
Please review and provide feedback.